<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />

  <title>Module: Analytics::Url</title>

  <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />

  <script src="../js/jquery.js" type="text/javascript" charset="utf-8"></script>
  <script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
  <script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
  <script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>

</head>
<body id="top" class="module">

  <div id="metadata">
    <div id="home-metadata">
      <div id="home-section" class="section">
        <h3 class="section-header">
          <a href="../index.html">Home</a>
          <a href="../index.html#classes">Classes</a>
          <a href="../index.html#methods">Methods</a>
        </h3>
      </div>
    </div>

    <div id="file-metadata">
      <div id="file-list-section" class="section">
        <h3 class="section-header">In Files</h3>
        <div class="section-body">
          <ul>
          
            <li><a href="../lib/graph_controller_extensions/url_analytics_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
              class="thickbox" title="lib/graph_controller_extensions/url_analytics.rb">lib/graph_controller_extensions/url_analytics.rb</a></li>
          
          </ul>
        </div>
      </div>

      
    </div>

    <div id="class-metadata">
      

      

      

      
      <!-- Method Quickref -->
      <div id="method-list-section" class="section">
        <h3 class="section-header">Methods</h3>
        <ul class="link-list">
          
          <li><a href="#method-i-get_slowest_url_data">#get_slowest_url_data</a></li>
          
          <li><a href="#method-i-get_time_consuming_url_data">#get_time_consuming_url_data</a></li>
          
          <li><a href="#method-i-get_top_db_consuming_url_data">#get_top_db_consuming_url_data</a></li>
          
          <li><a href="#method-i-get_url_calls_graph">#get_url_calls_graph</a></li>
          
          <li><a href="#method-i-get_url_data">#get_url_data</a></li>
          
          <li><a href="#method-i-get_url_hits_data">#get_url_hits_data</a></li>
          
        </ul>
      </div>
      

      
    </div>

    <div id="project-metadata">
      
      
      <div id="fileindex-section" class="section project-section">
        <h3 class="section-header">Files</h3>
        <ul>
        
          <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a></li>
        
        </ul>
      </div>
      

      <div id="classindex-section" class="section project-section">
        <h3 class="section-header">Class/Module Index
          <span class="search-toggle"><img src="../images/find.png"
            height="16" width="16" alt="[+]"
            title="show/hide quicksearch" /></span></h3>
        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
        <fieldset>
          <legend>Quicksearch</legend>
          <input type="text" name="quicksearch" value=""
            class="quicksearch-field" />
        </fieldset>
        </form>

        <ul class="link-list">
        
          <li><a href="../Analytics.html">Analytics</a></li>
        
          <li><a href="../Analytics/Database.html">Analytics::Database</a></li>
        
          <li><a href="../Analytics/ResourceUsage.html">Analytics::ResourceUsage</a></li>
        
          <li><a href="../Analytics/Throughput.html">Analytics::Throughput</a></li>
        
          <li><a href="../Analytics/Url.html">Analytics::Url</a></li>
        
          <li><a href="../Analytics/UrlBreakup.html">Analytics::UrlBreakup</a></li>
        
          <li><a href="../ActionView.html">ActionView</a></li>
        
          <li><a href="../ActionView/Helpers.html">ActionView::Helpers</a></li>
        
          <li><a href="../ActionView/Helpers/AssetTagHelper.html">ActionView::Helpers::AssetTagHelper</a></li>
        
          <li><a href="../AdminController.html">AdminController</a></li>
        
          <li><a href="../AdminHelper.html">AdminHelper</a></li>
        
          <li><a href="../App.html">App</a></li>
        
          <li><a href="../AppException.html">AppException</a></li>
        
          <li><a href="../AppTimeSample.html">AppTimeSample</a></li>
        
          <li><a href="../ApplicationController.html">ApplicationController</a></li>
        
          <li><a href="../ApplicationHelper.html">ApplicationHelper</a></li>
        
          <li><a href="../ApplicationSpecification.html">ApplicationSpecification</a></li>
        
          <li><a href="../ApplicationSpecificationController.html">ApplicationSpecificationController</a></li>
        
          <li><a href="../ApplicationSpecificationHelper.html">ApplicationSpecificationHelper</a></li>
        
          <li><a href="../Control.html">Control</a></li>
        
          <li><a href="../ExceptionDetail.html">ExceptionDetail</a></li>
        
          <li><a href="../ExceptionsController.html">ExceptionsController</a></li>
        
          <li><a href="../ExceptionsHelper.html">ExceptionsHelper</a></li>
        
          <li><a href="../GraphController.html">GraphController</a></li>
        
          <li><a href="../GraphHelper.html">GraphHelper</a></li>
        
          <li><a href="../Headers.html">Headers</a></li>
        
          <li><a href="../HeadersController.html">HeadersController</a></li>
        
          <li><a href="../HeadersHelper.html">HeadersHelper</a></li>
        
          <li><a href="../MailSpecification.html">MailSpecification</a></li>
        
          <li><a href="../MailSpecificationController.html">MailSpecificationController</a></li>
        
          <li><a href="../MailSpecificationHelper.html">MailSpecificationHelper</a></li>
        
          <li><a href="../Mailer.html">Mailer</a></li>
        
          <li><a href="../Object.html">Object</a></li>
        
          <li><a href="../PseudoModel.html">PseudoModel</a></li>
        
          <li><a href="../ResourceUsage.html">ResourceUsage</a></li>
        
          <li><a href="../SCGI.html">SCGI</a></li>
        
          <li><a href="../ServerSpecification.html">ServerSpecification</a></li>
        
          <li><a href="../ServerSpecificationController.html">ServerSpecificationController</a></li>
        
          <li><a href="../ServerSpecificationHelper.html">ServerSpecificationHelper</a></li>
        
          <li><a href="../SignalHelper.html">SignalHelper</a></li>
        
          <li><a href="../UrlBreakupTimeSample.html">UrlBreakupTimeSample</a></li>
        
          <li><a href="../UrlTimeSample.html">UrlTimeSample</a></li>
        
          <li><a href="../User.html">User</a></li>
        
          <li><a href="../YAMLConfig.html">YAMLConfig</a></li>
        
          <li><a href="../YAMLWriter.html">YAMLWriter</a></li>
        
        </ul>
        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
      </div>

      
    </div>
  </div>

  <div id="documentation">
    <h1 class="module">Analytics::Url</h1>

    <div id="description" class="description">
      
    </div><!-- description -->

    
    
    
    <div id="5Buntitled-5D" class="documentation-section">
      

      

      

      

      <!-- Methods -->
      
      <div id="public-instance-method-details" class="method-section section">
        <h3 class="section-header">Public Instance Methods</h3>

      
        <div id="get_slowest_url_data-method" class="method-detail ">
          <a name="method-i-get_slowest_url_data"></a>

          
          <div class="method-heading">
            <span class="method-name">get_slowest_url_data</span><span
              class="method-args">()</span>
            <span class="method-click-advice">click to toggle source</span>
          </div>
          

          <div class="method-description">
            
            <p>This method is used to get the data for slowest urls for a specific
application from the <a href="../UrlTimeSample.html">UrlTimeSample</a>
model. This data is supplied to the bar graph method to plot the bar graph.</p>
            

            
            <div class="method-source-code" id="get_slowest_url_data-source">
<pre>
<span class="ruby-comment"># File lib/graph_controller_extensions/url_analytics.rb, line 60</span>
    <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_slowest_url_data</span>
      <span class="ruby-identifier">app_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">to_i</span>
      <span class="ruby-identifier">from_date</span>, <span class="ruby-identifier">to_date</span> = <span class="ruby-identifier">get_date_for_bar_graphs</span>  
      <span class="ruby-identifier">urls</span>, <span class="ruby-identifier">time</span>, <span class="ruby-identifier">max</span>, <span class="ruby-identifier">slab</span> = <span class="ruby-constant">UrlTimeSample</span>.<span class="ruby-identifier">get_url_calls_data</span>(<span class="ruby-identifier">app_id</span>, <span class="ruby-identifier">from_date</span>, <span class="ruby-identifier">to_date</span>, <span class="ruby-string">&quot;slowesturl&quot;</span>)
<span class="ruby-comment">#      bar_graph(urls, time, SLOWEST_URLS_GRAPH_TITLE, max, slab, &quot;&quot;, &quot;Average Time (in ms)&quot;)</span>
      <span class="ruby-identifier">horizontal_graph</span>(<span class="ruby-identifier">urls</span>, <span class="ruby-identifier">time</span>, <span class="ruby-constant">SLOWEST_URLS_GRAPH_TITLE</span>, <span class="ruby-identifier">max</span>, <span class="ruby-identifier">slab</span>, <span class="ruby-string">&quot;&quot;</span>, <span class="ruby-string">&quot;Average Time (in ms)&quot;</span>)      
    <span class="ruby-keyword">end</span></pre>
            </div><!-- get_slowest_url_data-source -->
            
          </div>

          

          
        </div><!-- get_slowest_url_data-method -->

      
        <div id="get_time_consuming_url_data-method" class="method-detail ">
          <a name="method-i-get_time_consuming_url_data"></a>

          
          <div class="method-heading">
            <span class="method-name">get_time_consuming_url_data</span><span
              class="method-args">()</span>
            <span class="method-click-advice">click to toggle source</span>
          </div>
          

          <div class="method-description">
            
            <p>This method is used to get the data for time consuming urls for a specific
application from the <a href="../UrlTimeSample.html">UrlTimeSample</a>
model. This data is supplied to the bar graph method to plot the bar graph.</p>
            

            
            <div class="method-source-code" id="get_time_consuming_url_data-source">
<pre>
<span class="ruby-comment"># File lib/graph_controller_extensions/url_analytics.rb, line 70</span>
    <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_time_consuming_url_data</span> 
      <span class="ruby-identifier">app_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">to_i</span>      
      <span class="ruby-identifier">from_date</span>, <span class="ruby-identifier">to_date</span> = <span class="ruby-identifier">get_date_for_bar_graphs</span>      
      <span class="ruby-identifier">urls</span>, <span class="ruby-identifier">time</span>, <span class="ruby-identifier">max</span>, <span class="ruby-identifier">slab</span> = <span class="ruby-constant">UrlTimeSample</span>.<span class="ruby-identifier">get_url_calls_data</span>(<span class="ruby-identifier">app_id</span>, <span class="ruby-identifier">from_date</span>, <span class="ruby-identifier">to_date</span>, <span class="ruby-string">&quot;timeconsumingurl&quot;</span>)
<span class="ruby-comment">#      bar_graph(urls, time, MOST_TIME_CONSUMING_GRAPH_TITLE, max, slab, &quot;&quot;, &quot;Total Time (in seconds)&quot;)</span>
      <span class="ruby-identifier">horizontal_graph</span>(<span class="ruby-identifier">urls</span>, <span class="ruby-identifier">time</span>, <span class="ruby-constant">MOST_TIME_CONSUMING_GRAPH_TITLE</span>, <span class="ruby-identifier">max</span>, <span class="ruby-identifier">slab</span>, <span class="ruby-string">&quot;&quot;</span>, <span class="ruby-string">&quot;Total Time (in seconds)&quot;</span>)
    <span class="ruby-keyword">end</span></pre>
            </div><!-- get_time_consuming_url_data-source -->
            
          </div>

          

          
        </div><!-- get_time_consuming_url_data-method -->

      
        <div id="get_top_db_consuming_url_data-method" class="method-detail ">
          <a name="method-i-get_top_db_consuming_url_data"></a>

          
          <div class="method-heading">
            <span class="method-name">get_top_db_consuming_url_data</span><span
              class="method-args">()</span>
            <span class="method-click-advice">click to toggle source</span>
          </div>
          

          <div class="method-description">
            
            <p>This method is used to get the data for top db consuming urls percentage db
usage data from the <a href="../UrlTimeSample.html">UrlTimeSample</a>
model. This data is supplied to the bar_grapd method to plot the bar graph.</p>
            

            
            <div class="method-source-code" id="get_top_db_consuming_url_data-source">
<pre>
<span class="ruby-comment"># File lib/graph_controller_extensions/url_analytics.rb, line 80</span>
    <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_top_db_consuming_url_data</span>
      <span class="ruby-identifier">app_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">to_i</span>
      <span class="ruby-identifier">from_date</span>, <span class="ruby-identifier">to_date</span> = <span class="ruby-identifier">get_date_for_bar_graphs</span>
      <span class="ruby-identifier">urls</span>, <span class="ruby-identifier">time</span>, <span class="ruby-identifier">max</span>, <span class="ruby-identifier">slab</span> = <span class="ruby-constant">UrlTimeSample</span>.<span class="ruby-identifier">get_url_calls_data</span>(<span class="ruby-identifier">app_id</span>, <span class="ruby-identifier">from_date</span>, <span class="ruby-identifier">to_date</span>, <span class="ruby-string">&quot;dbcosumingurl&quot;</span>)
<span class="ruby-comment">#      bar_graph(urls, time, TOP_DATABASE_CONSUMING_URLS_GRAPH_TITLE, max, slab,&quot;&quot;, &quot;Time (in seconds)&quot;)</span>
      <span class="ruby-identifier">horizontal_graph</span>(<span class="ruby-identifier">urls</span>, <span class="ruby-identifier">time</span>, <span class="ruby-constant">TOP_DATABASE_CONSUMING_URLS_GRAPH_TITLE</span>, <span class="ruby-identifier">max</span>, <span class="ruby-identifier">slab</span>,<span class="ruby-string">&quot;&quot;</span>, <span class="ruby-string">&quot;Time (in seconds)&quot;</span>)
    <span class="ruby-keyword">end</span></pre>
            </div><!-- get_top_db_consuming_url_data-source -->
            
          </div>

          

          
        </div><!-- get_top_db_consuming_url_data-method -->

      
        <div id="get_url_calls_graph-method" class="method-detail ">
          <a name="method-i-get_url_calls_graph"></a>

          
          <div class="method-heading">
            <span class="method-name">get_url_calls_graph</span><span
              class="method-args">(app_id)</span>
            <span class="method-click-advice">click to toggle source</span>
          </div>
          

          <div class="method-description">
            
            <p>This method is to populate the varriable url_hits_graph,slowest_url_graph
and time_consuming_url_graph with the respective graphs data.
url_hits_graph contains the data for url hits for an application.
slowest_url_graph contains the data for slowest urls of an application.
time_consuming_url_graph contains the data for top time consuming urls of
an application.</p>
            

            
            <div class="method-source-code" id="get_url_calls_graph-source">
<pre>
<span class="ruby-comment"># File lib/graph_controller_extensions/url_analytics.rb, line 28</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_url_calls_graph</span>(<span class="ruby-identifier">app_id</span>)
  <span class="ruby-identifier">url_hits_graph</span> = <span class="ruby-identifier">plot_graph</span>(<span class="ruby-node">&quot;graph/get_url_hits_data/#{app_id}&quot;</span>, <span class="ruby-string">'url_hits'</span>)<span class="ruby-comment"># Graph is depicting the application specific url hits</span>
  <span class="ruby-identifier">slowest_url_graph</span> = <span class="ruby-identifier">plot_graph</span>(<span class="ruby-node">&quot;graph/get_slowest_url_data/#{app_id}&quot;</span>, <span class="ruby-string">'slowest_url'</span>)<span class="ruby-comment"># Graph is depicting the Slowest Url</span>
  <span class="ruby-identifier">time_consuming_url_graph</span> = <span class="ruby-identifier">plot_graph</span>(<span class="ruby-node">&quot;graph/get_time_consuming_url_data/#{app_id}&quot;</span>, <span class="ruby-string">'time_consuming_url'</span>)<span class="ruby-comment"># Graph is depicting the Time consuming Url</span>
  <span class="ruby-identifier">db_consuming_url_graph</span> = <span class="ruby-identifier">plot_graph</span>(<span class="ruby-node">&quot;graph/get_top_db_consuming_url_data/#{app_id}&quot;</span>, <span class="ruby-string">'top_db_consuming_url'</span>)<span class="ruby-comment">#Graph depicts the top database consuming urls      </span>
  <span class="ruby-keyword">return</span> <span class="ruby-identifier">url_hits_graph</span>, <span class="ruby-identifier">slowest_url_graph</span>, <span class="ruby-identifier">time_consuming_url_graph</span>, <span class="ruby-identifier">db_consuming_url_graph</span>
<span class="ruby-keyword">end</span></pre>
            </div><!-- get_url_calls_graph-source -->
            
          </div>

          

          
        </div><!-- get_url_calls_graph-method -->

      
        <div id="get_url_data-method" class="method-detail ">
          <a name="method-i-get_url_data"></a>

          
          <div class="method-heading">
            <span class="method-name">get_url_data</span><span
              class="method-args">(app_id)</span>
            <span class="method-click-advice">click to toggle source</span>
          </div>
          

          <div class="method-description">
            
            <p>This method renders the partial containing url call Graphs for an
application.</p>
            

            
            <div class="method-source-code" id="get_url_data-source">
<pre>
<span class="ruby-comment"># File lib/graph_controller_extensions/url_analytics.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_url_data</span>(<span class="ruby-identifier">app_id</span>)
  <span class="ruby-ivar">@app_id</span> = <span class="ruby-identifier">app_id</span>      
  <span class="ruby-identifier">urls</span> = <span class="ruby-constant">UrlTimeSample</span>.<span class="ruby-identifier">get_urls</span>(<span class="ruby-identifier">session</span>[<span class="ruby-value">:from_date</span>], <span class="ruby-identifier">session</span>[<span class="ruby-value">:to_date</span>], <span class="ruby-identifier">app_id</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">urls</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>        
    <span class="ruby-ivar">@url_hits_graph</span>, <span class="ruby-ivar">@slowest_url_graph</span>, <span class="ruby-ivar">@time_consuming_url_graph</span>, <span class="ruby-ivar">@db_consuming_url_graph</span> = <span class="ruby-identifier">get_url_calls_graph</span>(<span class="ruby-identifier">app_id</span>)        
  <span class="ruby-keyword">else</span>
    <span class="ruby-identifier">flash</span>[<span class="ruby-value">:notice</span>] = <span class="ruby-constant">NO_DATA_FOUND</span>
  <span class="ruby-keyword">end</span>      
  <span class="ruby-identifier">render</span> <span class="ruby-value">:partial</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'url_calls_graph'</span>
<span class="ruby-keyword">end</span></pre>
            </div><!-- get_url_data-source -->
            
          </div>

          

          
        </div><!-- get_url_data-method -->

      
        <div id="get_url_hits_data-method" class="method-detail ">
          <a name="method-i-get_url_hits_data"></a>

          
          <div class="method-heading">
            <span class="method-name">get_url_hits_data</span><span
              class="method-args">()</span>
            <span class="method-click-advice">click to toggle source</span>
          </div>
          

          <div class="method-description">
            
            <p>This method is used to get the data for url hits for a specific application
from the <a href="../UrlTimeSample.html">UrlTimeSample</a> model. This data
is supplied to the bar graph method to plot the bar graph.</p>
            

            
            <div class="method-source-code" id="get_url_hits_data-source">
<pre>
<span class="ruby-comment"># File lib/graph_controller_extensions/url_analytics.rb, line 50</span>
    <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_url_hits_data</span>
      <span class="ruby-identifier">app_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">to_i</span>
      <span class="ruby-identifier">from_date</span>, <span class="ruby-identifier">to_date</span> = <span class="ruby-identifier">get_date_for_bar_graphs</span>
      <span class="ruby-identifier">urls</span>,<span class="ruby-identifier">number_of_requests</span>,<span class="ruby-identifier">max</span>,<span class="ruby-identifier">slab</span> = <span class="ruby-constant">UrlTimeSample</span>.<span class="ruby-identifier">get_url_calls_data</span>(<span class="ruby-identifier">app_id</span>, <span class="ruby-identifier">from_date</span>, <span class="ruby-identifier">to_date</span>, <span class="ruby-string">&quot;requests&quot;</span>)
<span class="ruby-comment">#      bar_graph(urls,number_of_requests, URL_HITS_GRAPH_TITLE, max, slab, &quot;&quot;, &quot;Number of Hits&quot;)</span>
      <span class="ruby-identifier">horizontal_graph</span>(<span class="ruby-identifier">urls</span>,<span class="ruby-identifier">number_of_requests</span>, <span class="ruby-constant">URL_HITS_GRAPH_TITLE</span>, <span class="ruby-identifier">max</span>, <span class="ruby-identifier">slab</span>, <span class="ruby-string">&quot;&quot;</span>, <span class="ruby-string">&quot;Number of Hits&quot;</span>)
    <span class="ruby-keyword">end</span></pre>
            </div><!-- get_url_hits_data-source -->
            
          </div>

          

          
        </div><!-- get_url_hits_data-method -->

      
      </div><!-- public-instance-method-details -->
    
    </div><!-- 5Buntitled-5D -->
  

  </div><!-- documentation -->

  <div id="validator-badges">
    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
      Rdoc Generator</a> 2</small>.</p>
  </div>

</body>
</html>

